What is @cspell/dict-en-gb?
@cspell/dict-en-gb is a dictionary package for the CSpell spell checker that provides British English word lists. It is used to enhance the spell-checking capabilities of CSpell by adding support for British English.
What are @cspell/dict-en-gb's main functionalities?
Adding British English Dictionary to CSpell
This feature allows you to add the British English dictionary to your CSpell configuration. By including 'en-gb' in the dictionaries array, CSpell will use the British English word list for spell checking.
{
"dictionaries": ["en-gb"]
}
Installation
This command installs the @cspell/dict-en-gb package as a development dependency in your project. This is the first step to enable British English spell checking in your project.
npm install -D @cspell/dict-en-gb
Configuration in cspell.json
This is an example of a cspell.json configuration file that sets the language to British English and includes the British English dictionary. This configuration ensures that CSpell uses the British English word list for spell checking.
{
"version": "0.2",
"language": "en-gb",
"dictionaries": ["en-gb"]
}
Other packages similar to @cspell/dict-en-gb
cspell-dict-pt-br
cspell-dict-pt-br provides a Brazilian Portuguese dictionary for CSpell. It is similar to @cspell/dict-en-gb but focuses on Brazilian Portuguese word lists.
@cspell/dict-fr-fr
@cspell/dict-fr-fr provides a French dictionary for CSpell. It is similar to @cspell/dict-en-gb but focuses on French word lists.
Cspell en_GB Dictionary
British English dictionary for cspell.
This is a pre-built dictionary for use with cspell.
Installation
Global Install and add to cspell global settings.
npm install -g @cspell/dict-en-gb
cspell link add @cspell/dict-en-gb
Uninstall from cspell
cspell link remove @cspell/dict-en-gb
Manual Installation
The cspell-ext.json
file in this package should be added to the import section in your cspell.json file.
{
"import": ["@cspell/dict-en-gb/cspell-ext.json"],
}
Building
Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.
npm run build
Adding Words
Please add any words to src/additional_words.txt by making a pull request.
License
MIT
Some packages may have other licenses included.